Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Turbopack: Register react refresh exports in module factory #8191

Merged
merged 4 commits into from
May 22, 2024

Conversation

wbinnssmith
Copy link
Member

This moves registration of a module’s exports with react refresh to within the module factory itself, rather than the code that executes the factory. This colocates this conditional code with the code that registers individual symbols, and allows us to only run it on modules that truly require refresh (i.e. user app code, not node_modules).

This moves registration of a module’s exports with react refresh to within the module factory itself, rather than the code that executes the factory. This colocates this conditional code with the code that registers individual symbols, and allows us to only run it on modules that truly require refresh (i.e. user app code, not `node_modules`).
Copy link

vercel bot commented May 21, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
examples-basic-web 🔄 Building (Inspect) Visit Preview 💬 Add feedback May 22, 2024 5:43pm
examples-nonmonorepo ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 22, 2024 5:43pm
rust-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 22, 2024 5:43pm
7 Ignored Deployments
Name Status Preview Comments Updated (UTC)
examples-designsystem-docs ⬜️ Ignored (Inspect) Visit Preview May 22, 2024 5:43pm
examples-gatsby-web ⬜️ Ignored (Inspect) Visit Preview May 22, 2024 5:43pm
examples-kitchensink-blog ⬜️ Ignored (Inspect) Visit Preview May 22, 2024 5:43pm
examples-native-web ⬜️ Ignored (Inspect) Visit Preview May 22, 2024 5:43pm
examples-svelte-web ⬜️ Ignored (Inspect) Visit Preview May 22, 2024 5:43pm
examples-tailwind-web ⬜️ Ignored (Inspect) Visit Preview May 22, 2024 5:43pm
examples-vite-web ⬜️ Ignored (Inspect) Visit Preview May 22, 2024 5:43pm

Copy link
Contributor

github-actions bot commented May 21, 2024

🟢 Turbopack Benchmark CI successful 🟢

Thanks

Copy link
Contributor

github-actions bot commented May 21, 2024

⚠️ CI failed ⚠️

The following steps have failed in CI:

  • Turbopack Rust tests (mac/win, non-blocking)

See workflow summary for details

Copy link
Contributor

✅ This change can build next-swc

@wbinnssmith wbinnssmith merged commit b0a9c9b into main May 22, 2024
54 of 56 checks passed
@wbinnssmith wbinnssmith deleted the wbinnssmith/module-refresh-2 branch May 22, 2024 23:40
wbinnssmith added a commit that referenced this pull request May 25, 2024
…8191)"

This caused issues with the Next.js test suite. See vercel/next.js#66128

This reverts commit b0a9c9b.
timneutkens pushed a commit that referenced this pull request May 26, 2024
…8191)" (#8214)

This caused issues with the Next.js test suite. See
vercel/next.js#66128

This reverts commit b0a9c9b.
timneutkens added a commit to vercel/next.js that referenced this pull request May 26, 2024
## What?

Update: Implemented a feature in Turbopack for `typeof window` inlining:
vercel/turborepo#8211. Verified the changes in that
PR + this PR fix the test 💯


Turbopack upgrade:

* vercel/turborepo#8081 <!-- Alexander Lyon - add
support for upload speed / remaining in the cache upload step -->
* vercel/turborepo#7673 <!-- Alexander Lyon -
[turbo-trace] add additional filter modes for allocs over time -->
* vercel/turborepo#8191 <!-- Will Binns-Smith -
Turbopack: Register react refresh exports in module factory -->
* vercel/turborepo#8195 <!-- Donny/강동윤 - feat:
Remove lint for `grid-template-areas`" -->
* vercel/turborepo#8207 <!-- Benjamin Woodruff -
chore: Remove unused `base16` dependency and dead `hex` wrapper function
-->
* vercel/turborepo#8185 <!-- Tim Neutkens - Update
contributing guide to mention snapshot test updating -->
* vercel/turborepo#8211 <!-- Tim Neutkens - Add
option for inlining typeof window -->
* vercel/turborepo#8214 <!-- Will Binns-Smith -
Revert "Turbopack: Register react refresh exports in module factory
(#8191)" -->

---

Previous PR description::

Implements a failing test for issue #66058.
The test only fails when using Turbopack.

While digging into that issue I found that `typeof window` replacement
is either not applied or does not cause `import()` or `require()` to be
removed. In the reproduction that approach is used to load a particular
package only in Node.js and another only in the browser.

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->
ForsakenHarmony pushed a commit to vercel/next.js that referenced this pull request Jul 25, 2024
…urborepo#8191)

This moves registration of a module’s exports with react refresh to
within the module factory itself, rather than the code that executes the
factory. This colocates this conditional code with the code that
registers individual symbols, and allows us to only run it on modules
that truly require refresh (i.e. user app code, not `node_modules`).
ForsakenHarmony pushed a commit to vercel/next.js that referenced this pull request Jul 25, 2024
ForsakenHarmony pushed a commit to vercel/next.js that referenced this pull request Jul 29, 2024
…urborepo#8191)

This moves registration of a module’s exports with react refresh to
within the module factory itself, rather than the code that executes the
factory. This colocates this conditional code with the code that
registers individual symbols, and allows us to only run it on modules
that truly require refresh (i.e. user app code, not `node_modules`).
ForsakenHarmony pushed a commit to vercel/next.js that referenced this pull request Jul 29, 2024
ForsakenHarmony pushed a commit to vercel/next.js that referenced this pull request Jul 29, 2024
…urborepo#8191)

This moves registration of a module’s exports with react refresh to
within the module factory itself, rather than the code that executes the
factory. This colocates this conditional code with the code that
registers individual symbols, and allows us to only run it on modules
that truly require refresh (i.e. user app code, not `node_modules`).
ForsakenHarmony pushed a commit to vercel/next.js that referenced this pull request Jul 29, 2024
ForsakenHarmony pushed a commit to vercel/next.js that referenced this pull request Aug 1, 2024
…urborepo#8191)

This moves registration of a module’s exports with react refresh to
within the module factory itself, rather than the code that executes the
factory. This colocates this conditional code with the code that
registers individual symbols, and allows us to only run it on modules
that truly require refresh (i.e. user app code, not `node_modules`).
ForsakenHarmony pushed a commit to vercel/next.js that referenced this pull request Aug 1, 2024
ForsakenHarmony pushed a commit to vercel/next.js that referenced this pull request Aug 14, 2024
Update: Implemented a feature in Turbopack for `typeof window` inlining:
vercel/turborepo#8211. Verified the changes in that
PR + this PR fix the test 💯

Turbopack upgrade:

* vercel/turborepo#8081 <!-- Alexander Lyon - add
support for upload speed / remaining in the cache upload step -->
* vercel/turborepo#7673 <!-- Alexander Lyon -
[turbo-trace] add additional filter modes for allocs over time -->
* vercel/turborepo#8191 <!-- Will Binns-Smith -
Turbopack: Register react refresh exports in module factory -->
* vercel/turborepo#8195 <!-- Donny/강동윤 - feat:
Remove lint for `grid-template-areas`" -->
* vercel/turborepo#8207 <!-- Benjamin Woodruff -
chore: Remove unused `base16` dependency and dead `hex` wrapper function
-->
* vercel/turborepo#8185 <!-- Tim Neutkens - Update
contributing guide to mention snapshot test updating -->
* vercel/turborepo#8211 <!-- Tim Neutkens - Add
option for inlining typeof window -->
* vercel/turborepo#8214 <!-- Will Binns-Smith -
Revert "Turbopack: Register react refresh exports in module factory
(#8191)" -->

---

Previous PR description::

Implements a failing test for issue #66058.
The test only fails when using Turbopack.

While digging into that issue I found that `typeof window` replacement
is either not applied or does not cause `import()` or `require()` to be
removed. In the reproduction that approach is used to load a particular
package only in Node.js and another only in the browser.

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

Closes NEXT-
Fixes #

-->
ForsakenHarmony pushed a commit to vercel/next.js that referenced this pull request Aug 15, 2024
Update: Implemented a feature in Turbopack for `typeof window` inlining:
vercel/turborepo#8211. Verified the changes in that
PR + this PR fix the test 💯

Turbopack upgrade:

* vercel/turborepo#8081 <!-- Alexander Lyon - add
support for upload speed / remaining in the cache upload step -->
* vercel/turborepo#7673 <!-- Alexander Lyon -
[turbo-trace] add additional filter modes for allocs over time -->
* vercel/turborepo#8191 <!-- Will Binns-Smith -
Turbopack: Register react refresh exports in module factory -->
* vercel/turborepo#8195 <!-- Donny/강동윤 - feat:
Remove lint for `grid-template-areas`" -->
* vercel/turborepo#8207 <!-- Benjamin Woodruff -
chore: Remove unused `base16` dependency and dead `hex` wrapper function
-->
* vercel/turborepo#8185 <!-- Tim Neutkens - Update
contributing guide to mention snapshot test updating -->
* vercel/turborepo#8211 <!-- Tim Neutkens - Add
option for inlining typeof window -->
* vercel/turborepo#8214 <!-- Will Binns-Smith -
Revert "Turbopack: Register react refresh exports in module factory
(#8191)" -->

---

Previous PR description::

Implements a failing test for issue #66058.
The test only fails when using Turbopack.

While digging into that issue I found that `typeof window` replacement
is either not applied or does not cause `import()` or `require()` to be
removed. In the reproduction that approach is used to load a particular
package only in Node.js and another only in the browser.

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

Closes NEXT-
Fixes #

-->
ForsakenHarmony pushed a commit to vercel/next.js that referenced this pull request Aug 16, 2024
## What?

Update: Implemented a feature in Turbopack for `typeof window` inlining:
vercel/turborepo#8211. Verified the changes in that
PR + this PR fix the test 💯


Turbopack upgrade:

* vercel/turborepo#8081 <!-- Alexander Lyon - add
support for upload speed / remaining in the cache upload step -->
* vercel/turborepo#7673 <!-- Alexander Lyon -
[turbo-trace] add additional filter modes for allocs over time -->
* vercel/turborepo#8191 <!-- Will Binns-Smith -
Turbopack: Register react refresh exports in module factory -->
* vercel/turborepo#8195 <!-- Donny/강동윤 - feat:
Remove lint for `grid-template-areas`" -->
* vercel/turborepo#8207 <!-- Benjamin Woodruff -
chore: Remove unused `base16` dependency and dead `hex` wrapper function
-->
* vercel/turborepo#8185 <!-- Tim Neutkens - Update
contributing guide to mention snapshot test updating -->
* vercel/turborepo#8211 <!-- Tim Neutkens - Add
option for inlining typeof window -->
* vercel/turborepo#8214 <!-- Will Binns-Smith -
Revert "Turbopack: Register react refresh exports in module factory
(#8191)" -->

---

Previous PR description::

Implements a failing test for issue #66058.
The test only fails when using Turbopack.

While digging into that issue I found that `typeof window` replacement
is either not applied or does not cause `import()` or `require()` to be
removed. In the reproduction that approach is used to load a particular
package only in Node.js and another only in the browser.

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants